Index
© 2006 - 2013 Ekahau, Inc.
| mod-service supports 13 commands: | Services: pos eve edp status route sensor msg cfg asset mod map sys tftp eng tag rec aprec test index |
| /epe/mod/mapview POST version | Input: | Output: | |
|
Description:
Gets a map image from given model. Default is active model. If the format parameter specified with value other then XML the service returns raw binary data with Content-Type set to image/png, image/jpeg or image/svg+xml depending on format parameter value. Example 1: View the image of map with id 0 from current model.
Role Required:
viewer
|
mapid (required) - [int] map id
modelid (optional) - [long] model id format (optional) - [String] content type of the response. Values are xml, png, jpg and svg. Default is xml. copy (optional) - [String] Show the original image or the smaller cached copy. Values are cached and orig. Default is original image. |
MAP.mapid - [int] map id
MAP.cachedscale - [String] scale factor of cached image MAP.data_b - [bin] image data |
|
| /epe/mod/modelbrowse POST version | Input: | Output: | |
|
Description:
The output depends on the type of the model. For a positioning model (*.esx) lists maps and zones defined in the model.Order is: 1st map and its zones, 2nd map and its zones, and so on. For a presence model (*.epx) lists sites defined in the model. Example 1: Browse current model. Example 2: Browse current model showing access point details. Example 3: Browse current model showing survey data without normalization.
Role Required:
viewer
|
modelid (optional) - [long] model id; default is the active model
accesspoint (optional) - [int] include access point and location beacon (e.g. IR) details survey (optional) - [String] possible values are [original, normalized]. If specified, include survey details, either original or normalized signal strength values. |
MODEL.qualityfilter - [int] position quality filter value, range 0-100
MODEL.referencecard - [String] normalization reference card MODEL.referencefunction - [String] normalization reference function name MODEL.scanningcard - [Array] scanning devices MODEL.scanningfunction - [Array] scanning normalization functions BUILDING.buildingid - [long] building id BUILDING.buildingname - [String] building name MAP.mapid - [int] map id MAP.mapname - [String] map name MAP.zonecount - [int] number of zones in the map MAP.scale - [String] scale of map image in scale units (deprecated use scalex and scaley) MAP.scalex - [String] scale of map image in pixels per meter for x-axis MAP.scaley - [String] scale of map image in pixels per meter for y-axis MAP.scaleunit - [String] scale unit, such as pixels per meter MAP.buildingid - [long] building id if the map belongs to a building MAP.format - [String] original map image format ZONE.zoneid - [int] zone id ZONE.zonename - [String] zone name ZONE.polygon - [String] list of coordinates of the zone's polygon ZONE.mapid - [int] id of the map where the zone belongs to SURVEY.surveyname - [String] survey name SURVEY.surveyid - [long] survey id SURVEY.signalstrength - [Array] survey signal strengths SURVEY.apid - [Array] survey access point id AP.apid - [long] access point id AP.apmac - [Array] access point MAC addresses AP.apssid - [Array] access point networks AP.apchannel - [Array] access point channels SIMUAP.apid - [long] simulated access point id SIMUAP.apname - [String] simulated access point name IRBEACON.irid - [long] infrared beacon id; 4 bytes in hexadecimal notation NORMALIZATION.devicetype - [Array] type ids of devices that have site-specific normalization defined in the model NORMALIZATION.devicedescription - [Array] descriptions of devices that have site-specific normalization defined in the model SITE.siteid - [long] id of a site in presence model SITE.sitename - [String] name of a site SITE.apmacrange - [Array] AP MAC addresses used to determine that a device is located at the site SITE.ipaddrrange - [long] IP addresses used to determine that a device is located at the site |
|
| /epe/mod/modeldelete POST version | Input: | Output: | |
|
Description:
Deletes a model. Example 1: Delete model with id 1.
Role Required:
poweruser
|
modelid (required) - [long] model id
|
||
| /epe/mod/modeldownload POST version | Input: | Output: | |
|
Description:
Downloads a model file either as BASE64 encoded XML or in native format. Example 1: Download a model file with id 1 as XML. The BASE64 encoded file is in data_b field. Example 2: Download a model file with id 1 as native.
Role Required:
poweruser
|
modelid (required) - [long] model id
format (optional) - [String] set to native to download file as native |
MODEL.modelid - [long] model id
MODEL.name - [String] model name MODEL.description - [String] free-form description MODEL.createdon - [String] create time of model MODEL.modifiedon - [String] modify time of model MODEL.type - [String] model type, such as edb or esx MODEL.size - [int] size of the model in bytes MODEL.version - [int] model version, initially '1' and incremented when a model is updated MODEL.data_b - [bin] model binary data |
|
| /epe/mod/modeledit POST version | Input: | Output: | |
|
Description:
Edits model description.
Role Required:
poweruser
|
modelid (required) - [long] model id
description (required) - [String] new description for the model |
||
| /epe/mod/modelgetactive POST version | Input: | Output: | |
|
Description:
Gets details of the active model. Example 1: Get information of the current positioning model.
Role Required:
viewer
|
type (optional) - [String] "esx"=positioning model, "epx"=presence model. defaults to "esx".
|
MODEL.modelid - [long] model id
MODEL.name - [String] model name MODEL.description - [String] free-form description MODEL.createdon - [String] create time of model MODEL.modifiedon - [String] modify time of model MODEL.type - [String] model type, such as edb or esx MODEL.size - [int] size of the model in bytes MODEL.version - [int] model version, initially '1' and incremented when a model is updated |
|
| /epe/mod/modellist POST version | Input: | Output: | |
|
Description:
Lists all models or one specific model in the database. The list is in upload order. Example 1: List all models. Example 2: List presence models. Example 3: Get model 1.
Role Required:
viewer
|
modelid (optional) - [Array] list of model ids
type (optional) - [String] "esx"=list only positioning models, "epx"=list only presence models |
MODEL.modelid - [long] model id
MODEL.name - [String] model name MODEL.description - [String] free-form description MODEL.createdon - [String] create time of model MODEL.modifiedon - [String] modify time of model MODEL.type - [String] model type, such as edb or esx MODEL.size - [int] size of the model in bytes MODEL.version - [int] model version, initially '1' and incremented when a model is updated |
|
| /epe/mod/modelsetactive POST version | Input: | Output: | |
|
Description:
Sets a model active. To unset the currently active model, call without any parameters. Example 1: Set model with id 1 active. Example 2: Unset currently active positioning model (after the call no active positioning model in the system).
Role Required:
poweruser
|
modelid (optional) - [long] model id
type (optional) - [String] "esx"=positioning model, "epx"=presence model.this is needed only when unsetting the active model (modelid=0) to specifywhich type of a model to deactivate. defaults to "esx". |
||
| /epe/mod/modelupdate POST version | Input: | Output: | |
|
Description:
Uploads a new version of an existing model. Model data is overwritten with the new data. This command should only be used if the new model data really is based on the old one. If the new model is not compatible with the old one, use the modelupload command to upload it as a separate model. Note that this command must be called with HTTP POST.
Role Required:
poweruser
|
modelid (required) - [String] id of an existing model to be updated
data_b (required) - [bin] model data name (optional) - [String] new model name; if omitted, the existing name is kept |
MODEL.modelid - [long] model id
MODEL.name - [String] model name MODEL.description - [String] free-form description MODEL.createdon - [String] create time of model MODEL.modifiedon - [String] modify time of model MODEL.type - [String] model type, such as edb or esx MODEL.size - [int] size of the model in bytes MODEL.version - [int] model version, initially '1' and incremented when a model is updated |
|
| /epe/mod/modelupload POST version | Input: | Output: | |
|
Description:
Uploads a model. Note that this command must be called with HTTP POST.
Role Required:
poweruser
|
name (required) - [String] model name
type (required) - [String] model type, the only supported value is esx data_b (required) - [bin] model data description (optional) - [String] description |
MODEL.modelid - [long] model id
MODEL.name - [String] model name MODEL.description - [String] free-form description MODEL.createdon - [String] create time of model MODEL.modifiedon - [String] modify time of model MODEL.type - [String] model type, such as edb or esx MODEL.size - [int] size of the model in bytes MODEL.version - [int] model version, initially '1' and incremented when a model is updated |
|
| /epe/mod/_clear | Input: | Output: | |
|
Description:
SPECIAL. Resets all service specific counters.
Role Required:
poweruser
|
|||
| /epe/mod/_list POST version | Input: | Output: | |
|
Description:
SPECIAL. Lists the available commands, their arguments, responses, required roles, call counters and optional help descriptions.
Role Required:
|
help (optional) - [int] set to 1 to get also HTML help description of the commands. Default is 0.
|
COMMAND.name - [String] command name
COMMAND.arg - [String] mandatory argument COMMAND.optarg - [String] optional argument COMMAND.response - [String] response field COMMAND.internal - [int] 1 for internal command COMMAND.role - [String] required role COMMAND.callcount - [int] number of calls COMMAND.callcountinternal - [int] number of internal calls COMMAND.callcountfailure - [int] number of failed calls COMMAND.htmlhelp - [String] command description in HTML format |
|
| /epe/mod/_status | Input: | Output: | |
|
Description:
SPECIAL. Returns status information about the service.
Role Required:
viewer
|
STATUS.callcount - [int] total number of calls for the service
STATUS.callcountinternal - [int] total number of internal calls for the service STATUS.callcountfailure - [int] total number of failed calls for the service STATUS.commandcount - [int] number of commands in service STATUS.* - [String] service specific status information |
||
(The data in this page was generated from /epe/mod/_list?help=1)